home *** CD-ROM | disk | FTP | other *** search
/ MacWorld 2003 August / MW 8 2003 CD1.iso / Inside Macworld / Product News / gimp-1.2.4.sit / gimp-1.2.4 / devel-docs / libgimp / tmpl / gimphelpui.sgml < prev    next >
Encoding:
SGML Document  |  2003-05-20  |  2.3 KB  |  123 lines
  1. <!-- ##### SECTION Title ##### -->
  2. gimphelpui
  3.  
  4. <!-- ##### SECTION Short_Description ##### -->
  5. Functions for setting #GtkTooltips and HTML links into the GIMP help
  6. system.
  7.  
  8. <!-- ##### SECTION Long_Description ##### -->
  9. <para>
  10.  
  11. </para>
  12.  
  13. <!-- ##### SECTION See_Also ##### -->
  14. <para>
  15.  
  16. </para>
  17.  
  18. <!-- ##### USER_FUNCTION GimpHelpFunc ##### -->
  19. <para>
  20. This is the prototype for all functions you pass as @help_func to the
  21. various GIMP dialog constructors like gimp_dialog_new(),
  22. gimp_query_int_box() etc.
  23. </para>
  24.  
  25. <para>
  26. Note that all help paths are relative to the root of the help system
  27. in the current language. So if your language is "C", a help path of
  28. "filters/foo_bar.html" will expand to
  29. "${gimp_data_dir}/help/C/filters/foo_bar.html".
  30. </para>
  31.  
  32. <para>
  33. All these functions finally call gimp_help_connect_help_accel() which
  34. does the work of installing the "F1" accelerator.
  35. </para>
  36.  
  37. <para>
  38. In most cases it will be ok to use gimp_plugin_help_func() which does
  39. nothing but passing the @help_data string to gimp_help(). If your
  40. plug-in needs some more sophisticated help handling you can provide
  41. your own @help_func which has to call gimp_help() to actually display
  42. the help.
  43. </para>
  44.  
  45. @help_data: A string containing the path to a HTML page.
  46.  
  47.  
  48. <!-- ##### FUNCTION gimp_help_init ##### -->
  49. <para>
  50.  
  51. </para>
  52.  
  53.  
  54.  
  55. <!-- ##### FUNCTION gimp_help_free ##### -->
  56. <para>
  57.  
  58. </para>
  59.  
  60.  
  61.  
  62. <!-- ##### FUNCTION gimp_help_enable_tooltips ##### -->
  63. <para>
  64.  
  65. </para>
  66.  
  67.  
  68.  
  69. <!-- ##### FUNCTION gimp_help_disable_tooltips ##### -->
  70. <para>
  71.  
  72. </para>
  73.  
  74.  
  75.  
  76. <!-- ##### FUNCTION gimp_standard_help_func ##### -->
  77. <para>
  78. This is the standard GIMP help function which does nothing but calling
  79. gimp_help(). Please use gimp_plugin_help_func() for your plug-in's
  80. help links.
  81. </para>
  82.  
  83. <para>
  84. Currently, gimp_standard_help_func() and gimp_plugin_help_func() do
  85. exactly the same. The latter one was introduced to ensure future
  86. flexibility.
  87. </para>
  88.  
  89. <para>
  90. See #GimpHelpFunc for the naming conventions of HTML help files.
  91. </para>
  92.  
  93. @help_data: A string containing the path to a HTML page.
  94.  
  95.  
  96. <!-- ##### FUNCTION gimp_help_connect_help_accel ##### -->
  97. <para>
  98.  
  99. </para>
  100.  
  101. @widget: 
  102. @help_func: 
  103. @help_data: 
  104.  
  105.  
  106. <!-- ##### FUNCTION gimp_help_set_help_data ##### -->
  107. <para>
  108.  
  109. </para>
  110.  
  111. @widget: 
  112. @tooltip: 
  113. @help_data: 
  114.  
  115.  
  116. <!-- ##### FUNCTION gimp_context_help ##### -->
  117. <para>
  118.  
  119. </para>
  120.  
  121.  
  122.  
  123.